Platform Explorer / Nuxeo Platform 2023.8

Component org.nuxeo.ecm.webapp.directory.DirectoryTreeService

Documentation

The DirectoryTreeService is used to build tree-shaped explorer like navigation menus (usging the <richfaces:tree /> components) from a hierarchical set of directories (with schemas "vocabulary" and "xvocabulary").

DirectoryTreeDescriptors also reference a QueryModel to update on node selection and a JSF view to display on node selection.

This is typically used to display results of a query where documents are filtered upon a hierachical property (such as the dc:coverage metadata for instance).

Requirements

Resolution Order

628
The resolution order represents the order in which this component has been resolved by the Nuxeo Runtime framework.
You can influence this order by adding "require" tags in your component declaration, to make sure it is resolved after another component.

Start Order

905
The start order represents the order in which this component has been started by the Nuxeo Runtime framework.
This number is interesting to tweak if your Java component interacts with other components, and needs to be started before or after another one.
It can be changed by implementing the method "Component#getApplicationStartedOrder()" on your Java component: components are sorted according to this reference value, in increasing order.
The default value is 1000, and the repository initialization uses number 100. Negative values can also be used.

Implementation

Class: org.nuxeo.ecm.webapp.directory.DirectoryTreeService

Services

Extension Points

XML Source

<?xml version="1.0"?>

<component name="org.nuxeo.ecm.webapp.directory.DirectoryTreeService">

  <!-- since 6.0, automatically registers actions -->
  <require>org.nuxeo.ecm.platform.actions.ActionService</require>

  <documentation>
    The DirectoryTreeService is used to build tree-shaped explorer like
    navigation menus (usging the &lt;richfaces:tree /&gt; components) from a hierarchical
    set of directories (with schemas "vocabulary" and "xvocabulary").

    DirectoryTreeDescriptors also reference a QueryModel to update on node selection
    and a JSF view to display on node selection.

    This is typically used to display results of a query where documents are filtered
    upon a hierachical property (such as the dc:coverage metadata for instance).

    @author Olivier Grisel (og@nuxeo.com)
  </documentation>

  <!-- XXX JC : see why this requirement
  <require>org.nuxeo.ecm.directory.DirectoryServiceImpl</require>
 -->
  <implementation
          class="org.nuxeo.ecm.webapp.directory.DirectoryTreeService" />
  <service>
    <provide interface="org.nuxeo.ecm.webapp.directory.DirectoryTreeService" />
  </service>
  <extension-point name="trees">
    <object
            class="org.nuxeo.ecm.webapp.directory.DirectoryTreeDescriptor" />
  </extension-point>
  <documentation>
    Registry for DirectoryTreeDescriptor instances used to build
    DirectoryTreeNodes.

    Extension point supports override and enable attribute in descriptor

    @author Olivier Grisel (og@nuxeo.com)
  </documentation>

</component>